Shareware Grab Bag

home *** CD-ROM | disk | FTP | other *** search

/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / dc4.arc / DC4.DOC < prev

Wrap

Text File | 1984-07-02 | 38.0 KB | 972 lines

sample DISKCAT(tm) version 4.2 DISK FILE CATALOG PROGRAM (C) Copyright 1983,1984 Nelson Ford Nelson Ford P.O.Box 61565 Houston, TX 77208 (713) 960-1347 CompuServe: 71355,470 Source: ST3564 DISKCAT - Disk File Catalog Program CONTENTS Hardware requirements .................................... 1 What DISKCAT does ........................................ 1 Incompatibilities with earlier versions & other programs . 2 Entering information ..................................... 2 DC4-READ.EXE Program Functions 1) Read a disk's files into the catalog ............... 2 2) Add descriptions to file names (DC4-CAT.EXE) ....... 3 3) Give a disk its own catalog ........................ 3 4) Delete a disk from the catalog ..................... 3 5) Display all files for a disk name .................. 3 6) Display all disk names ............................. 3 7) Print a hardcopy catalog listing (DC4-SORT.EXE) .... 3 8) Purge deleted files from catalog ................... 3 9) Change program parameters .......................... 3 Entering printer control codes ................... 3 DC4-CAT.EXE Program Functions 1) Enter file category and description ................ 4 2) Volume name entries ................................ 4 3) Subdirectory name entries .......................... 4 4) Automatic file descriptions ........................ 4 5) [Alt]-key commands ................................. 4 DC4-SORT.EXE Program Functions 1) Compare two catalogs ............................... 6 2) Print catalog sorted by file name, disk name, file type, date or filename extension ... 6 Sending data to the disk ................................. 6 Specifying a range to print .............................. 6 Data file structure ...................................... 7 Other ways to edit and print the catalog ................. 7 Starting a new catalog ................................... 7 Suggestions for using DISKCAT............................. 7 Using DOS 2's FIND.EXE to locate a file in the catalog ... 8 Assigning categories ..................................... 8 DISTRIBUTION OF DISKCAT PROGRAMS ......................... 9 Source code .............................................. 9 Acknowledgement of suggestions for improvements .......... 10 Invoice Trademark credits for this manual: PC-FILE(tm) - Jim Button Lotus 1-2-3(tm) - Lotus Development Corp. DISKCAT - Disk File Catalog Program Page 1 HARDWARE REQUIREMENTS: Minimum: 128K (192 on Compaq), one disk drive, 80-column monitor. Recommended: a RAM disk-emulator or hard disk to hold the data printer, graphics board. DOS: 1.0 1.1 2.0 2.1 Maximum # of file name entries: up to 3000, depending on memory. WHAT DISKCAT DOES: DISKCAT keeps track of all of your disk files - no more sticking disk after disk into a drive to see if the file you need is on it. DC4-READ.EXE reads a disk's directory, adds file names, date and size to a catalog file, gives a disk its own table-of-contents file, prints a file listing to keep with each disk, deletes a disk from the catalog file, displays names of all disks in the catalog, along with number of sectors and sides and free space remaining on each disk, allows changing program parameters. DC4-CAT.EXE add file category and description, rename files/disk, delete file, view file contents, locate file/disk in catalog. DC4-SORT.EXE sorts, prints the catalog file; it will compare two catalog files and print a comparative list showing differences and matching files; creates new catalog file; prints to screen or printer or disk file for later printing; creates data file in a format that can be read by Lotus 1-2-3. All or part of a catalog can be sorted by file name, disk name, file type, date or file extension. DC4-FIND.EXE is a quick way to search the catalog for a specific file to find which disk it is on. DC4-DOC.EXE contains an introduction to DISKCAT and prints the DC4.DOC documentation file to the screen or printer. DC4-PGM.DTA contains the program parameters: file names, drives, screen colors, printer controls. DC4-SAMP.DTA and DC3-SAMP.DT2 are samples of the two data files created by DISKCAT. The first contains the file catalog with the following information about each file: file name, size, creation time and date, file category and description and disk name. The second data file contains the number of disks and files in the catalog and the following information about each disk: disk name, number of sides and sectors, free space, and the catalog record number of the disk's first and last files. The disks in this catalog are the "greatest hits" of public domain software. Write for information about obtaining these disks by trading or for a nominal fee. DISKCAT - Disk File Catalog Program Page 2 INCOMPATIBILITIES: DC4-CAT.EXE uses keys that may be intercepted by some utility programs such as Prokey. Such programs must be exited before using DC4-CAT.EXE, but may be left active with DC4-READ & SORT. If you have been using a version of DISKCAT earlier than 3.0, you must use the program DC4-CNVT.BAS to convert DC4.DTA's re- cord format to the current format. The current format has a 36-character description field, increased from 25 characters. You may keep the names of your data files if you wish by using the "Modify program parameters" option in DC4-READ to change the default data file name. ENTERING INFORMATION: When entering data, the edit keys work the same way that they do in BASIC and in most word processors. The cursor keys move the cursor in the data field. If you press the Enter key after the cursor has been moved back into the middle of an entry, the whole entry is still accepted. If a prompt is displayed, pressing Enter will cause the prompt to be accepted as data input. Entering a character at the start of the field causes the default data to be erased so that new data can be entered. To edit the prompted data, press the Insert or Delete keys or move into the data field with the cursor keys. Entering a character in other than the start of the field will not cause the prompt to disappear. The End and Home keys will move the cursor to the end and start of the field, respectively. Toggle the Insert mode by pressing the Ins key. Holding the Ctrl key while pressing the left or right cursor keys will move the cur- sor from word to word within the prompt or, if the cursor is at the start or end of the field will move the cursor to the prior or next field, if any. Pressing the up or down cursor keys will move the cursor to the field above or below the current field, if any. Pressing the Ctrl and End keys together will delete the characters from the cursor to the end of the field. Pressing the Del key will delete the character at the cursor position. DC4-READ.EXE Program Functions (Main Menu): 1) Read a disk's files into the catalog. -prompts for a name for the disk. If the disk has a volume label, it is made the default disk name. When asked for a disk name, press Enter to use the default name. -checks to see if name is already used. If so, choices are * delete the disk from the file * read the disk and update the file This option allows you to update a disk's records without wiping out the file descriptions for files that are still on the disk. If a file has the same name but a different file size or date, the name, category and description are retained and the size and date are updated. * enter another disk name -file names, size & date are read from disk, sorted by name and added to the data file with the "DTA" extension. The disk name, disk type (number of sides & sectors) and free space remaining are added to the data file with the "DT2" extension. DISKCAT - Disk File Catalog Program Page 3 (DC4-READ Program Functions, continued:) 2) Add descriptions to file names. (See DC4-CAT) 3) Give a disk its own catalog. -puts a directory listing on a disk with file descriptions. The file can be TYPEd from DOS to review contents of disk. If you gave the volume name a description, it is displayed in the heading of the listing along with the disk name. 4) Delete a disk from the catalog. -removes all files from the catalog that belong to the disk that is being deleted. 5) Display all files for a disk name. -allows a list to be made of file names and descriptions for a disk. The printout can be inserted into the disk sleeve for reference. 6) Display all disk names. -also diplays # sectors, # sides and free space. 7) Print a hardcopy catalog listing. -goes to the DC4-SORT program to print a catalog file. (DC4-SORT is discussed in detail later.) 8) Purge deleted files from catalog. -eliminates records that have been marked for deletion. NOTE: compressing records in a random access file does not change the file size in the directory. To change the file size, copy DC4.DTA in DOS using /A which will cause DOS to stop at the EOF marker. (See COPY in DOS manual.) -the catalog should be purged before creating a new file via DC4-SORT. 9) Change program parameters. -allows you to change the names of the DISKCAT programs and data files to suit your taste. You can use this option to change catalogs if you have more than one catalog file. -change default drives and screen colors. -put in printer commands for your printer. Example: To put the Epson/IBM printer into compressed print, you must send the printer an ASCII 15. From BASIC, to put the Epson into compressed print you would type LPRINT CHR$(15). So in the DC4-READ program, enter the print control code as CHR$(15). Press Alt-E or Alt-I or Alt-O to get the control codes for Epson, IDS, or Okidata printers, respectively. Others must be entered manually as described. DISKCAT - Disk File Catalog Program Page 4 DC4-CAT.EXE Program Functions: 1) Displays the disk name and file name and prompts for a 10- character file category and 36-character file description. The categories displayed at the top of the screen can be entered into the category field by entering the number or highlighted characters of the desired category name. 2) DOS 2 volume labels are automatically given a category name of "Vol. Name" so that all disk names will print out in a group when the file is sorted and printed by category. In the description field enter a description of disk contents. 3) DOS 2 subdirectory names are automatically given a category name of "Subdir.". 4) The following is a list of filename extensions and their de- fault descriptions which automatically appear. Press Enter to accept a default description or enter a new description. EXTENSION DEFAULT DESCRIPTION ---------------- ------------------------------------ EXAMPLE.ASM Assm. source code for EXAMPLE.EXE EXAMPLE.DOC Documentation file for EXAMPLE EXAMPLE.DTA/.DAT Data file for EXAMPLE EXAMPLE.HEX EXAMPLE in hex format for downloading EXAMPLE.OBJ File used to generate EXAMPLE.EXE EXAMPLE.VC VisiCalc template to ... EXAMPLE.WKS/.PRN 123 template to ... 5) Several commands are available to make entering descriptions easier and quicker. The commands are displayed at the bottom of the screen. They are executed by holding the Alt key and pressing the appropriate key. The key to press is indicated by being highlighted and capitalized on the screen. It will be the same key as is shown in brackets in the following: [P] Prior entry: displays previous entry. (Ctrl-left arrow: same) [F] Find file: finds a file from all or part of the name and makes it the current record. [D] Find disk: finds a disk from all or part of the name, and makes the first file on the disk the current record. Optionally, skips files in the data data file not on the selected disk. The point of this last option is that when a disk is up- dated, new files on the disk are added to the end of the catalog. As a result all the files for a disk will no longer be grouped together in the catalog. This option allows only the files for a specific disk to be viewed. [K] Kill file: marks the displayed entry for deletion by the "Purge" routine. Also allows the file to be deleted from the disk. DISKCAT - Disk File Catalog Program Page 5 (DC4-CAT.EXE Program Functions, continued:) [V] View file: displays contents of a file one screen at a time, to aid in entering file descriptions. If the file is not an ASCII file, the display may be meaningless, unless it is a BASIC program, in which case it will be translated to ASCII. [R] Repeat entry: repeats category & description from previous file: for programs with multiple files, such as FK.DOC, FK.HEX, FK.COM. Also see [F1-F10]. [S] Skip disk: finds the next disk name and makes its first file the current record. [C] Edit categories: allows you to change the category names. The names will be sorted and re-displayed when you are through making changes. [N] Rename disk/file: (1) Change the name of a disk throughout the catalog file. (2) Rename a file in the catalog file and on the disk. [B] Find Blank description: finds the next file in the catalog with a blank description field. [M] Manual entry: Allows a manual entry to be made for non-DOS disks, such as Flight Simulator. [F1-F10] Memorize/recall a category and description: IF THE FUNCTION KEY DOES NOT HAVE ANYTHING ASSIGNED TO IT: -The next category and description entered will be assigned to the function key pressed. -If the current file already has a category and description that you want assigned to the Fkey, press Enter twice. -Otherwise, enter a category and description or press [Esc] to abort. -The Fkey number and first six characters of the description will be displayed at the bottom of the screen. IF THE FUNCTION KEY ALREADY HAS A CATEGORY AND DESCRIPTION: -They will become the prompts for the current file. -Press Enter twice to accept the prompts or press [Alt] and a different function key to recall different prompts. -Or press [Esc] to clear the function key. The program will then be ready to assign new text to the Fkey. If you do not want to set up this function key, press [Esc] again. DISKCAT - Disk File Catalog Program Page 6 DC4-SORT.EXE Program Functions: 1) Compare two catalogs. -compares two catalogs and prints a comparative list. This function is designed to facilitate comparing software lib- raries by different user groups or individuals who collect public domain software. 2) Print catalog sorted by file name, disk name, file type, date or filename extension. Print Options: 1) Output can be sent to the screen, the printer, or to a disk. 2) When the data in the sorted field, such as disk name, changes, you may choose to skip two lines on the printout, skip to the top of the next page, or not skip at all. 3) Data sent to a disk file can be formatted in three ways: -the same as the printout (to dump to a printer later.) -as a LOTUS 1-2-3 ".PRN" file (to be loaded into 1-2-3.) -as a new catalog file. When a disk is first read, all of its files are grouped together. When a disk in the catalog is re-read and the catalog updated, new files are added to the end of the catalog. Then when the catalog is searched for the files of a particular disk the program must search longer. By sorting the catalog by disk name and creating a new catalog file, you can cut down on disk search time. 4) You may specify a range to print. Examples: -to print file names starting with A through M, enter A as the starting parameter and M as the ending one. If you get the message "Out of string space" when trying to load and print the entire catalog, you may have to use use this op- tion to print one part of the catalog at a time. -to print all files with the category of "BASIC Util", first select "Sort by category" then specify "BASIC Util" as the starting and ending parameters. DATA FILES: 1) DC4-PGM.DTA contains the program parameters. This file must always be present to run DISKCAT. (The information in this file used to be included in DC#.NFO with the disk data.) 2) ***.DTA is a random access file containing file names & info. Record layout: file name 12 spaces disk name 8 spaces file type 10 spaces file descrip. 36 spaces file date 8 spaces file size 6 spaces car. rtn./l.f. 2 spaces (carriage return & line feed) -- record length 82 3) ***.DT2 is a sequential file containing disk names & info. as well as the number of files and disks in the catalog. DISKCAT - Disk File Catalog Program Page 7 OTHER WAYS TO EDIT AND PRINT THE CATALOG: The DC4.DTA file can be TYPEd from DOS. It can also be edited by text processors if these warnings are heeded: -IBM's Personal Editor should be used with the NOTABS option when saving. Otherwise, it replaces blanks with tabs, which destroys the necessary uniform record length. -WordStar can be used in the Non-document mode only. -Enter data exactly as in the other records. (eg: the dot [.] in the file name must always be in column 9). -If records are added or deleted with text processors, the number of files (the second number in the .DT2 file) must be changed and the first and last record numbers for each disk name must be updated. The record numbers of the first and last records of each disk can be updated by selecting the PURGE option at the main menu of DC4-READ. A .PRN file can be created from DC4.DTA using DC4-SORT.EXE. This file can be loaded into LOTUS 1-2-3 for further manipulation. The DC4.DTA can be sorted and printed using Jim Button's PC-FILE. The file must first be sorted by PC-FILE in order to create an index file. STARTING A NEW CATALOG: When you receive DISKCAT it is set to read the DC4-SAMP files. To create your own catalog file, run DC4-READ and edit the program parameters. Change DC4-SAMP to whatever you like and respond "Y" when asked "Make the changes permanent?" The program will look for whatever filename you entered on whatever drive you specified and will complain about not finding it. Just press Esc and the file will be created. SUGGESTIONS FOR USING DISKCAT: As already mentioned, this program makes it easy for user groups to catalog and describe their public domain software libraries and to compare them with other groups. Because disks can be read so quickly, libraries of up to 3000 files each can be read and compared in a matter of minutes. People who have a hard disk that is backed up on floppy disks will find that by keeping the catalog file on the hard disk, you can use DOS 2's FIND.EXE or DC4-FIND to find in seconds which disk a file is backed up on. Those without a hard disk may find it handy to have a printout of the catalog sorted by filename for reference at times when it is not convenient to load DISKCAT. DISKCAT - Disk File Catalog Program Page 8 USING DOS 2's FIND.EXE ("FIND")- FIND will search for a string of characters anywhere in a file. You may prefer to use FIND instead of DC4-FIND.EXE to search the catalog. To use it to display all files of a particular category, such as "DOS Util", enter the following: FIND "DOS Util" DC4.DTA Notice that upper case and lower case must be correct to find a match. Also, the file extension must be right-justified: to find the file, TEST.BAS, you must specify "TEST .BAS". A batch file to make FIND a little easier to use can be created by typing in the following at the DOS prompt: COPY CON: F.BAT FIND "%1" DC4.DTA (press F6 to get a ^Z) With this batch file, you can just enter F and the characters in the file that you want to locate. To use DC4-FIND.EXE, at the A> prompt, enter DC4-FIND. You will be prompted for all or part of a file name to search for. ASSIGNING CATEGORIES- The Category is meant to be a "key field" that you can use to get similar file to print out together. Let's say you are classifying the DISKCAT programs. For Category, you could call DC4-CAT.EXE a "Disk catalog" file, the .DOC file a "Documentation" file, the .DTA file a "Data file". But when you sort by Category, do you want to see all the documentation files listed by themselves and all the data files by themselves? You might prefer to classify all related files the same as the main program, so that they will be grouped together when printing a list sorted by Category. If you use the Categories displayed at the top of the screen, you will be assured that file categories that you want to match will match exactly so that they will print out together. To edit the Categories, press Alt-C in the "Add Descriptions" program, as de- cribed earlier. DISKCAT - Disk File Catalog Program Page 9 DISTRIBUTION OF DISKCAT PROGRAMS- A limited license is granted to copy the COMPILED versions of the DISKCAT version 4.2 programs and the associated files under the following conditions: 1. Copying is for the sole purpose of allowing potential buyers of the program an opportunity to try out DISKCAT before paying for it. 2. The BASIC source code should not be needed for such an evalua- tion, therefore, it may not be copied or distributed. 3. All copyright notices must be left intact and this documenta- tion file included. 4. All the compiled programs must be offered as a complete set. 5. These programs are not to be distributed as part of any commercial endeavor, such as, but not limited to, software give-aways (or sales) by vendors, "magazines-on-a-disk", or groups that charge more than a small "copying fee" for a disk with these files. The programs, excluding the uncompiled BASIC programs, may be included in all electronic bulletin boards and PC user group libraries, provided that the following type of notice is given users: "May be copied for evaluation purposes only. If you decide to use the programs, payment to author is expected." Minor enhancements are made weekly and major changes, monthly. With this in mind, customers who have paid may get the latest changes by sending in a disk plus $5. Others should try the bulletin boards and user groups for an evaluation copy. Group purchase terms (and commissions) are available to user groups who wish to sell DISKCAT. Write for details. Since there is no way for me to control the continued distri- bution of outdated copies of DISKCAT, users should be aware that changes in the program, the price or in the terms of dis- tribution may have changed since this version. SOURCE CODE- Registered users may get the source code for DISKCAT by sending a DSDD formatted disk, ppd. mailer plus $5. The source code for DISKCAT may NOT be copied and distributed. If you make changes or have suggestions for improvements I am interested in hearing of them, but no modified versions of DISKCAT may be copied and distributed, since I have no way to help other users when they have problems with the modified versions. I have enough trouble fixing my own mistakes! DISKCAT - Disk File Catalog Program Page 10 Acknowledgements for Suggestions: (1) Kill file from disk when deleting entry from DISKCAT. (2) Show free space on disk along with file name. (James Jacques Delafield,WI) (3) Show disk type (# sectors and # sides) along with file name. (Bob Duval Charleston, SC) (4) Include DC4.HDR file for easier use with PC-FILE. (5) Read DOS 2.0 subdirectories (possible future enhancement. I would first like to know if many people are using subdirectories on floppies.) (John Burns Mattawan, MI) (6) Several people have suggested a routine to print a disk directory on a label to be attached to the disk. The reasons that this has not been done yet are (1) the idea of this program is to make it easy to locate files using the DC4-FIND program or a sorted list printed out, (2) disk contents change easily, disk labels change less easily, and (3) there are several programs in the public domain already that print such labels. Another problem is squeezing 112 files onto a label that will fit on the disk. One company has solved this by using the subscript character set for the Epson printer. What do people without Epsons do? As a substitute, option 6 at the main menu [Display All Files for a Disk] will let you print out a list to be inserted into the disk's sleeve. This routine prints the name and descrip- tion of all the files in two columns. To get the printout to fit into a diskette sleeve, you need to set your printer to compressed print (15+ char. per inch) by setting the printer switches or entering the control codes in the DC4-READ program. (7) Put time and date on catalog listings. (8) Sort the disk names. (9) When sorting and printing the catalog, insert blank lines or a form feed when the sorted field changes. (George Margolin Newport Beach, CA) (10) Allow a file to be renamed from within program. (11) Allow a disk to be renamed in the catalog file. (John Markley Homer, LA) (12) Allow screen colors to be changed from within the program. (Mike Hawkins whereabouts unknown) DISKCAT - Disk File Catalog Program Page 11 (13) Allow the user to enter a range to print in DC4-SORT. (14) Make the disk's volume name the default disk name. (15) Allow the user to assign a volume name from DC4-CAT. (16) Add routine to read files on hard disk. (17) Add some color. (18) In printouts, place size and date fields adjacent to file name for easier reading. (19) Read the disk name from the (DOS 2) volume label. Other people have suggested reading the volume label from the directory to use for the disk name, but it seemed like more trouble that it was worth. But Michael Roland also has a very clever idea for using the volume names. Michael came up with the idea of giving each disk's volume name (which is read along with the other file names from the directory) the same category so that all of the disks' volume names will be grouped together when the file is printed by DC4-SORT sorted by category. Now why didn't I think of that? He also suggests using the "Add descriptions" routine to add a description of disk contents to the volume name entry. (Michael B. Roland Dammam, Saudi Arabia) (20) Speed up the sort 600-900%. (21) Put time and date on comparative printout and mark matching files to make them easier to spot. (22) Show on the printout which field the file was sorted on. (23) Add an option to allow printing the data file sorted by date. (24) Make it easier to delete a disk from the file. (25) Change the symbol for a deleted record from "z" to "/" to be compatible with PC-FILE. (Pete Smothers, President, New Orleans PC User Group) Pete backed up his suggestions with BASIC code. Using the sort routine he provided, a sort that took 5 minutes 15 seconds with the routine I was using now takes 7 seconds! The first time I tried it, I thought that it had kicked out of the routine without sorting. Boy was I surprised! Thanks, Pete. 4.0 (26) SPLIT "ADD CATEGORIES" INTO ITS OWN PROGRAM. I fought this as long as possible, wanting to keep the speed of having as many functions as possible in one program, but kept running out of room in the main program. The new feature that pushed it over the limit this time was keeping track of each file's first and last record number in the data base. When you have a large data base, this will greatly speed up functions that search for all files for a particular disk. (27) Allow program parameters to be changed from within the program. I have always been annoyed at not being able to look at two different catalog files on my hard disk without moving or renaming them. Now this is possible. (Me, Houston, Texas) (29) Make the documentation easier to read and make it easier to start a new catalog. (George Margolin Newport Beach, CA) 4.1 (30) Added the routines to allow the entry and use of printer control codes. (31) Added routines to allow temporarily assigning file categories and descriptions to function keys to be recalled and assigned to other file names. DISKCAT - Disk File Catalog Program Page 12 Changes to DC4-CAT: 4.2 (32) Routine to allow manual entries for non-DOS disks. (33) Routine to View BASIC programs not saved in ASCII. (34) Fixed bug that hung up system when end of file reached while adding descriptions under the option that skips all files not on a specified disk. (whew!) (reported by Jim Layfield) (36) Replaced code (stolen by gremlins) that saves changes made to categories. (37) Added routine to display NumLock and CapsLock status. (38) Fixed bug in DC4-READ that truncated right digit of file size if over 99,999. (39) Fixed bug in DC4-SORT that kept printout from starting a new page when a change in the sorted field occurred. (Thanks to my chief bug-finder: Dwight Espensen, who has long been keeping me honest.) (40) Removed the data file name DC4.DTA from DC4-FIND.EXE. (41) Added option to DC4-SORT to pause at each page to change paper. (Suggested by David Romer, Toronto, Ontario, Canada, who also provided enough info to allow me to track down another elusive bug that follows:) (42) Fixed bug that deleted the last file name for a disk if it did not have a volume label. DISKCAT 5.0 will allow reading subdirectories. With this version, the disk name field will be expanded to 11 characters to be compatible with the actual volume name on the disk. Any suggestions for major changes should be made now. - ------------------------------------------------------- * * * * * * * * * * I N V O I C E * * * * * * * * * * ------------------------------------------------------- D I S K C A T Please make check payable to: Nelson Ford P.O.Box 61565 Houston, TX 77208 (713) 960-1347 Date: _____________ Name: _________________________________ Address: ______________________________ ______________________________ Qty. Price Total --- ----- ---------- DISKCAT Disk File Catalog Program ___ @ $30 $_________ (Software - No Texas sales tax.) Thank you for your order.